<html>

<head>
<meta http-equiv="Content-Language" content="en-us">
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
<meta name="GENERATOR" content="Microsoft FrontPage 4.0">
<meta name="ProgId" content="FrontPage.Editor.Document">
<title>Hapsby Readme</title>
</head>

<body link="#666699" vlink="#666699" alink="#666699">

<p align="center"><font size="3">Hapsby Readme</font></p>
<p align="center"><font size="3">Last updated: 7/18/01</font></p>
<p align="center"><font size="3">(C) 2000-2001 Hugues Johnson</font></p>
<p align="center"><font size="1">** This readme is meant to be a &quot;quick
start&quot; guide -- please see <a href="docs/index.html">index.html</a> in the
'help' folder for more **</font></p>
<hr color="#666699">
<p align="center"> <font size="3"> Hapsby Distribution sites</font></p>
<p align="left"><font size="3">Hapsby Homepage: <a href="http://www.huguesjohnson.com/">http://www.HuguesJohnson.com/</a></font></p>
<p align="left">Video Game Webpage Services: <a href="http://www.vgws.com/">http://www.vgws.com/</a></p>
<p align="left"><font size="3">Zophar's Domain: <a href="http://www.zophar.net/">http://www.zophar.net/</a></font></p>
<p align="left"><font size="1">If you did not download this program from one of these sites
please contact the author.</font></p>
<hr color="#666699">
<p align="left"><font size="3">What's in this distribution:</font></p>
<table border="0" width="100%">
  <tr>
    <td width="33%">
      <p align="left"><b><u><font size="3">Directory</font></u></b></td>
    <td width="33%">
      <p align="left"><b><u><font size="3">Contents</font></u></b></td>
    <td width="34%">
      <p align="left"><b><u><font size="3">Notes</font></u></b></td>
  </tr>
  <tr>
    <td width="33%"><font size="3">Hapsby\bin\&nbsp;</font></td>
    <td width="33%"><font size="3">executable jar
file (Hapsby.jar)</font></td>
    <td width="34%"></td>
  </tr>
  <tr>
    <td width="33%"><font size="3">Hapsby\bin\def\</font></td>
    <td width="33%"> <font size="3"> sample save
game definitions</font></td>
    <td width="34%"> <font size="3"> store new .hsd files here</font></td>
  </tr>
  <tr>
    <td width="33%"><font size="3">Hapsby\bin\backup\</font></td>
    <td width="33%"> <font size="3"> backup
files .hbk</font></td>
    <td width="34%"><font size="3">backups can be restored in main program</font></td>
  </tr>
  <tr>
    <td width="33%"><font size="3">Hapsby\bin\themes\</font></td>
    <td width="33%"><font size="3">images</font></td>
    <td width="34%"><font size="3">root folder for themes to be stored in</font></td>
  </tr>
  <tr>
    <td width="33%"><font size="3">Hapsby\bin\themes\Default</font></td>
    <td width="33%"><font size="3">default theme</font></td>
    <td width="34%"></td>
  </tr>
  <tr>
    <td width="33%"><font size="3">Hapsby\bin\themes\Phantasy_Star_II</font></td>
    <td width="33%"><font size="3">Phantasy Star II theme</font></td>
    <td width="34%"></td>
  </tr>
  <tr>
    <td width="33%"><font size="3">Hapsby\bin\themes\Phantasy_Star_IV</font></td>
    <td width="33%"><font size="3">Phantast Star IV theme</font></td>
    <td width="34%"></td>
  </tr>
  <tr>
    <td width="33%"><font size="3">Hapsby\bin\settings\</font></td>
    <td width="33%"><font size="3">program settings and logs</font></td>
    <td width="34%"><font size="3">don't mess with this folder</font></td>
  </tr>
  <tr>
    <td width="33%"><font size="3">Hapsby\bin\win32\</font></td>
    <td width="33%"><font size="3">batch file to launch in win32 platforms</font></td>
    <td width="34%"></td>
  </tr>
  <tr>
    <td width="33%"><font size="3">Hapsby\help\&nbsp;</font></td>
    <td width="33%"> <font size="3"> help files</font></td>
    <td width="34%">
<font size="3">
open the file index.html to navigate the help</font></td>
  </tr>
  <tr>
    <td width="33%"><font size="3">Hapsby\source\</font></td>
    <td width="33%"><font size="3">source code</font></td>
    <td width="34%"></td>
  </tr>
</table>
<p align="left" style="margin-top: 0; margin-bottom: 0">&nbsp;</p>
<p align="left" style="margin-top: 0; margin-bottom: 0"><font size="3">If you have something drastically
different than this please contact the author.</font></p>
<hr color="#666699">
<p align="left"><font size="3">Contents</font></p>
<ol>
  <li>
    <p align="left"><a href="#System_Requirements"><font size="3">System Requirements</font></a></li>
  <li>
    <p align="left"><a href="#Installation"><font size="3">Installation</font></a></li>
  <li>
    <p align="left"><a href="#Using_Hapsby"><font size="3">Using Hapsby</font></a></li>
  <li>
    <p align="left"><a href="#Creating_save_game_definitions"><font size="3">Creating save game definitions (.hsd)</font></a></li>
  <li>
    <p align="left"><a href="#Contacting_the_author"><font size="3">Contacting the author</font></a></li>
  <li>
    <p align="left"><a href="#Legal_notes"><font size="3">Legal notes</font></a></li>
</ol>
<hr color="#666699">
<p align="left"><font size="3">1. <a name="System_Requirements"> System Requirements</a></font></p>
<p align="left"><font size="3">Real simple, you need to have the Java Runtime Environment
version 1.3.0 or later installed. This is packaged Netscape 6+
and some versions of Linux.</font></p>
<p align="left"><font size="3">Currently, the Java Runtime Environment is available at
<a href="http://java.sun.com/j2se/1.3/jre/">http://java.sun.com/j2se/1.3/jre/</a>.</font></p>
<p align="left"><font size="3">Presently, Hapsby has only been tested under Windows 2000.
However, this program should work under any operating system with Java
compatibility.</font></p>
<hr color="#666699">
<p align="left"><font size="3">2. <a name="Installation"> Installation</a></font></p>
<p align="left"><font size="3">Extract the file hapsby.zip, make sure you extract with the full
path (&quot;Extract Files with Full Path&quot; or &quot;Use Folder Names&quot;
are typical options). From here you can either run the executable jar file, or build
the source yourself.</font></p>
<p align="left"><font size="3">Running under Windows 95/98/2000/NT: navigate to the
\bin\win32 folder and run the file Hapsby.bat. Right now, Windows 2000 seems
to be able to run a jar file by just double-clicking it; if that doesn't work
for you, use the .bat file.</font></p>
<p align="left"><font size="3">Running under other platforms: Please check the Java
documentation for running a jar executable under your operating system. The
Hapsby.jar file is located in the \bin folder. Typically you would enter
&quot;java -jar Hapsby.jar&quot; from a command line.</font></p>
<p align="left"><font size="3">Building the source: You must have JDK1.3.0 (or later)
installed. See the file \source\build-win32.bat for an example of how to properly
build the source.&nbsp;</font></p>
<hr color="#666699">
<p align="left"><font size="3">3. <a name="Using_Hapsby"> Using Hapsby</a></font></p>
<p align="left"><font size="3">This is a very brief quick start guide.... please see the help
folder for a real guide.</font></p>
<p align="left"><font size="3">Select a save game to browse for from the list on the left.
Pressing the &quot;Open Save Game&quot; button or menu will open the save game
browser. Navigate to the file you want to edit and open it.</font></p>
<p align="left"><font size="3">The game description and properties will load in the right
panel. Select a property to edit and the panel will update with the information
about that property. All that's left is to enter a new value in the
&quot;Current Value&quot; box, and press the &quot;Save&quot; button.&nbsp;</font></p>
<hr color="#666699">
<p align="left"><font size="3">4. <a name="Creating_save_game_definitions"> Creating save game definitions</a> (.hsd)</font></p>
<p align="left"><font size="3">This is a very basic guide, see the help file for a better tutorial.</font></p>
<p align="left"><font size="3">When saving the files <b>do not use blank spaces in the filename</b>.
Not all Java compatible operating systems support spaces in file names,
therefore Hapsby does not support spaces in file names.</font></p>
<p align="left"><font size="3">Hapsby save definition files must be in this form:</font></p>
<p align="left" style="margin-top: 0; margin-bottom: 0"><font size="1">Game
Title</font></p>
<p align="left" style="margin-top: 0; margin-bottom: 0"><font size="1">Game
Description</font></p>
<p align="left" style="margin-top: 0; margin-bottom: 0"><font size="1">Save File
Name/Pattern</font></p>
<p align="left" style="margin-top: 0; margin-bottom: 0"><font size="1">Total
Number of Properties</font></p>
<p align="left" style="margin-top: 0; margin-bottom: 0"><font size="1">Property1
Name</font></p>
<p align="left" style="margin-top: 0; margin-bottom: 0"><font size="1">Property1
Description</font></p>
<p align="left" style="margin-top: 0; margin-bottom: 0"><font size="1">Property1
Data Type</font></p>
<p align="left" style="margin-top: 0; margin-bottom: 0"><font size="1">Property1
Address (in decimal representation)</font></p>
<p align="left" style="margin-top: 0; margin-bottom: 0"><font size="1">Property1
Length (in decimal representation)</font></p>
<p align="left" style="margin-top: 0; margin-bottom: 0"><font size="1">Property1
Minimum Value (in decimal representation)</font></p>
<p align="left" style="margin-top: 0; margin-bottom: 0"><font size="1">Property1
Maximum Value (in decimal representation)</font></p>
<p align="left"><b><u><font size="3">Description of Fields:</font></u></b></p>
<p align="left"><font size="3">Game Title: Title of the game.</font></p>
<p align="left"><font size="3">Game Description: Description of game. Include information about
what type of save state this is, and other relevant information. May be in html
format.</font></p>
<p align="left"><font size="3">Save File Pattern: What the name/pattern of the save game is.
For example: Nesticle save states would be *.st*, and Genecyst save states would
be *.gs*. Wildcards can only be leading or trailing - something like *.g*0 will <b>not</b>
work.</font></p>
<p align="left"><font size="3">Total Number of Properties: Number of properties. Incorrect property count
value will cause problems.&nbsp;</font></p>
<p align="left"><font size="3">Property (n) Name: Name of the property.</font></p>
<p align="left"><font size="3">Property (n) Description: Description of property. May be in
html format.</font></p>
<p align="left"><font size="3">Property (n) Data Type: Presently, the only valid data types value
are 1 (integer, low byte stored first), and 2 (integer, high byte stored first). Future
versions will hopefully support character/string data types.</font></p>
<p align="left"><font size="3">Property (n) Address: Starting address of property. Must be in
decimal format. For example, and address starting at 0BC1 would have an address
of 3009.</font></p>
<p align="left"><font size="3">Property (n) Length: Number of bytes. Just about every NES or
SMS game uses 1 byte (8-bit) for everything (except for experience points in
RPGs). Just about every Genesis game uses 2 bytes (16-bit) for everything.</font></p>
<p align="left"><font size="3">Property (n) Minimum Value: Minimum value for the property,
usually 0.</font></p>
<p align="left"><font size="3">Property (n) Maximum Value: Maximum value for the property.
Usually it's something like 255 or 65535, it's a good idea to check the manual
in advance to see.</font></p>
<p align="left"><font size="3">Skipping a line will cause problems.&nbsp;</font></p>
<p align="left"> <font size="3"> Here is an example of a valid save game definition:</font></p>
<p align="left"><font size="1">Defender of the Crown<br>
&lt;html>&lt;font color=#666699>&lt;b>&lt;p>Nesticle X save state for Defender of the Crown.&lt;/p>&lt;p>For best results save game on the map screen.&lt;/p&gt;&lt;/b>&lt;/font>&lt;/html><br>
*.st*<br>
4<br>
Gold<br>
&lt;html>&lt;font color=#666699>&lt;b>Amount of gold.&lt;/b>&lt;/font>&lt;/html><br>
1<br>
9687<br>
1<br>
0<br>
255<br>
Soldiers<br>
&lt;html>&lt;font color=#666699>&lt;b>Number of soldiers in your army.&lt;/b>&lt;/font>&lt;/html><br>
1<br>
9619<br>
1<br>
0<br>
255<br>
Knights<br>
&lt;html>&lt;font color=#666699>&lt;b>Number of knights in your army.&lt;/b>&lt;/font>&lt;/html><br>
1<br>
9625<br>
1<br>
0<br>
255<br>
Catapults<br>
&lt;html>&lt;font color=#666699>&lt;b>Number of catapults in your army.&lt;/b>&lt;/font>&lt;/html><br>
1<br>
9631<br>
1<br>
0<br>
255<br>
</font></p>
<hr color="#666699">
<p align="left"><font size="3">5. <a name="Contacting_the_author"> Contacting the author</a></font></p>
<p align="left"><font size="3">Here are the guidelines for contacting the me:</font></p>
<ol>
  <li>
    <p align="left"><font size="3">Please see if your inquiry is covered in the FAQ - check
    <a href="http://www.huguesjohnson.com/">HuguesJohnson.com</a> for the most recent version</font></li>
  <li>
    <p align="left"><font size="3">Do not ask any programming questions.</font></li>
  <li>
    <p align="left"><font size="3">Do not send any files.</font></li>
  <li>
    <p align="left"><font size="3">Do not ask me to send you any files.</font></li>
  <li>
    <p align="left"><font size="3">Please include the word &quot;Hapsby&quot; somewhere in your
    subject line or my junk mail filter will certainly delete your message
    before I ever see it.</font></li>
  <li>
    <p align="left"><font size="3">On the topic of junk mail filters, messages with vulgar
    content will also be automatically deleted.</font></li>
</ol>
<p align="left"><font size="3">Any mail sent outside of these guidelines will be deleted.</font></p>
<p align="left"><font size="3">With those guidelines in mind, I can be reached at: <a href="mailto:sin@iconnect.net">sin@iconnect.net</a>.
I try to respond to every message personally. Don't expect a response
to arrive swiftly, it will take a minimum of 3-5 days.&nbsp;</font></p>
<hr color="#666699">
<p align="left"><font size="3">6. <a name="Legal_notes"> Legal notes</a></font></p>
<p align="left"><font size="2">Java and Solaris are trademarks of <a href="http://java.sun.com/">Sun
Microsystems</a></font></p>
<p align="left"><font size="2">Windows is a trademark of <a href="http://microsoft.com/">Microsoft</a></font></p>
<p align="left"><font size="2">Netscape Communicator is a trademark of <a href="http://netscape.com/">Netscape</a></font></p>
<p align="left"><font size="2">NES is a trademark of <a href="http://www.nintendo.com/">Nintendo</a></font></p>
<p align="left"><font size="2">SMS and Genesis are trademarks of <a href="http://www.sega.com/">Sega</a></font></p>
<p align="left"><font size="2">This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your option)
any later version.</font></p>
<p align="left"><font size="2">This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
details.</font></p>
<p align="left"><font size="2">You should have received a copy of the GNU General Public
License along with this program; if not, write to the Free Software Foundation,
Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.</font></p>
<p align="left"><font size="2">All written content is property of <a href="http://"> Hugues
Johnson</a>.</font></p>

</body>

</html>
